'\" t
.\"     Title: abidos_cpp
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 02/20/2013
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "ABIDOS_CPP" "1" "02/20/2013" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
abidos_cpp \- parses C++ projects then generates UML browse\-able diagrams in the future re\-factor will be available\&.
.SH "SYNOPSIS"
.sp
\fBabidos_cpp\fR [\-\-brief|\-\-verbose] [\-\-test_original] [\-\-ts_show] [\-\-test_all_tokens_consumed_flag] [\-\-no_std] [\-\-no_repeat_files] [\-\-no_url_flag] [\-l <FILE> | \-\-loader <FILE>] [\-i <DIR> | \-\-includes <DIR>] [\-o <DIR> | \-\-out_dir <DIR>] [\-w <FILE> | \-\-white_list <FILE>] [\-v <FILE> | \-\-version <FILE>]
.SH "DESCRIPTION"
.sp
Abidos parses C++\&.
.SH "OPTIONS"
.PP
\fB\-\-brief\fR
.RS 4
abidos shows less trace messages\&.
.RE
.PP
\fB\-\-verbose\fR
.RS 4
abidos shows more trace messages\&.
.RE
.PP
\fB\-\-test_original\fR
.RS 4
abidos generates a \&.cpp file to check if the parser works well with an example test/\fItNUMBER\fR\&.cpp the output is in test_out/out_
\fItNUMBER\fR\&.cpp, for now this is experimental and not all source file is in the output\&.
.RE
.PP
\fB\-\-ts_show\fR
.RS 4
abidos shows the
\fIsymbols_table\fR
at the end of his execution\&.
.RE
.PP
\fB\-\-test_all_tokens_consumed_flag\fR
.RS 4
abidos test system uses this flag to know if all tokens has been processed at the end of the file test\&.
.RE
.PP
\fB\-\-no_std\fR
.RS 4
classes of the
\fIstandard library\fR
are now showed\&.
.RE
.PP
\fB\-\-no_repeat_files\fR
.RS 4
loader does not process repeated files\&.
.RE
.PP
\fB\-\-no_url_flag\fR
.RS 4
in
\fIUML\fR
\fIdot format\fR
diagrams URLs are not generated therefore browse able feature won\(cqt be available\&.
.RE
.PP
\fB\-l, \-\-loader\fR \fIFILE\fR
.RS 4
loader process each
\fI*\&.cpp\fR
in
\fIFILE\fR
and generates the UML diagrams of the all files inside it\&. The default
\fIFILE\fR
is
\fI\&.abidos_cpp/files_input\fR
and each line has this format: file\&.cpp:dir_includes_1:dir_includes_2\&...
.RE
.PP
\fB\-i, \-\-includes\fR \fIDIR\fR
.RS 4
if some include files are not found abidos will search it in
\fIDIR\fR\&.
.RE
.PP
\fB\-o, \-\-out_dir\fR \fIDIR\fR
.RS 4
the output files of abidos will be in
\fIDIR\fR\&.
.RE
.PP
\fB\-w, \-\-white_list\fR \fIFILE\fR
.RS 4
in the output
\fIUML\fR
diagram only appears the classes put in this
\fIFILE\fR\&. Each line has the name of a
\fICLASS\fR\&.
.RE
.PP
\fB\-v, \-\-version\fR
.RS 4
abidos shows his version and exit\&.
.RE
.SH "BUGS"
.sp
See the Abidos git repository\&.
.SH "AUTHOR"
.sp
Abidos was originally written by Fructu\&.
.SH "RESOURCES"
.sp
github: Abidos project https://github\&.com/fructu/abidos_cpp/ Abidos doc https://github\&.com/fructu/abidos_cpp_doc
.SH "COPYING"
.sp
Copyright (C) 2011\-2013 Fructu Free use of this software is granted under the terms of the GNU General Public License (GPL)\&.
